home *** CD-ROM | disk | FTP | other *** search
/ MACD 5 / MACD 5.bin / workbench / wb / czesc_4 / wbgenie / wbgenie.doc < prev    next >
Text File  |  1993-03-13  |  19KB  |  508 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.                                  WBGenie V1.02
  21.  
  22.                                 November 10, 1992
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.                     © Copyright 1992 by Steven Velletri
  52.                        All Rights Reserved Worldwide
  53.  
  54.  
  55. Important Legal Information
  56.  
  57. Permission is granted to freely copy and distribute this package by all
  58. mediums, provided no charge or fee is ask for, and no modifications
  59. are made to this package.
  60.  
  61. The program WBGenie, all supporting programs, and related documentation
  62. are copyrighted © 1992 by Steven Velletri. All rights are reserved worldwide.
  63.  
  64. This program is SHAREWARE. If you find it useful, please send $25 and
  65. and obtain a registered copy of WBGenie. See below for details on how to
  66. register.
  67.  
  68. The wbgenie software and documentation is provided "as is" without warranty
  69. of any kind, either expressed or implied, including, but not limited to the
  70. implied warranties of merchantability and fitness for a particular purpose.
  71. You are advised to test the software thoroughly before relying on it.  You
  72. agree to accept the entire risk as to the quality and performance of the
  73. software and documentation.  In no event will Steven Velletri be liable for
  74. direct, indirect, incidental, or consequential damages resulting from any
  75. defect in the program.
  76.  
  77. Steven Velletri reserves the right to make improvements to the product and
  78. documentation at any time and without notice.
  79.  
  80. Please support the continued development of quality Amiga software by
  81. registering the software which you find useful.
  82.  
  83. Please contact the author. If you think any of the above conditions are
  84. being violated.  Thank you.
  85.  
  86.  
  87. Have You Registered? -- if you haven't.
  88. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  89. WBGenie is shareware.  If you find this program useful, please send $25
  90. (Australian) to:
  91.  
  92.     Steven Velletri
  93.     P.O. Box 342
  94.     Hamilton Hill
  95.     WA 6163
  96.     Australia
  97.  
  98. Please send payment in one of the following forms:
  99.  
  100.     Australian cash (be very careful!)
  101.     Australian check in Australian dollars
  102.     Australian money order in Australian dollars
  103.  
  104. Companies
  105. ~~~~~~~~~
  106. Companies which wish to use WBGenie for more than one employee should
  107. purchase a separate license for each employee.  Enterprise licenses are
  108. available for large companies.  Please contact the author for details.
  109.  
  110. In return for your contribution of $25 or more, you will receive a diskette
  111. containing the most recent version of WBGenie, its support program
  112. files and complete documentation. A separate registration form is included
  113. in the documents directory called register.doc, or you can print a
  114. registration form from within the shareware version of WBGenie.
  115.  
  116. Please promote the shareware system by making a contribution to the authors
  117. of the shareware products you commonly use.
  118.  
  119. To discourage software piracy, the full name and address of each registered
  120. user will be encoded in their own personalized registered version of
  121. WBGenie. To see this, select "Register" from the "Program" menu.
  122.  
  123. Special Thanks
  124. ~~~~~~~~~~~~~~
  125. The following people have assisted me with the developement of this product:
  126.  
  127.     Michael Fulgaro
  128.         He lent me his computer while I was waiting for my 250Meg seagate
  129.         hard disk to arrive. It took over 2 months !!
  130.  
  131.     ADAWA (Amiga Developers Association of Western Australia)
  132.         They helped Beta test WBGenie and helped me with many technical
  133.         difficulties - Many Thanks.
  134.  
  135. Getting Started
  136. ~~~~~~~~~~~~~~~
  137. It is recommended that you copy the WBGenie program to your
  138. :tool/commodities directory and place the project (i.e. config files) file
  139. you finally create in the wbstartup directory. Other project files should
  140. be kept in a directory to which the assign WBGenie: has been made.
  141.  
  142. Eg. copy the entire WBGenie draw to your utilities draw and add the
  143. following in your s:user-startup script:
  144.  
  145.     assign WBGenie: sys:utilities/WBGenie
  146.  
  147. All your configuration could be stored in this directory.
  148.  
  149. This is only recommended however as there are numerous ways to install
  150. WBGenie.
  151.  
  152. What is  WBGenie?
  153. ~~~~~~~~~~~~~~~~~
  154. WBGenie is a WB program launcher with a difference. It is intended to be
  155. a WB interface to a set of WB programs (which I am in the process of
  156. writing) to make performing housekeeping chores on the Amiga
  157. simple. There are already shareware and public domain programs which
  158. perform housekeeping functions. You may very easily configure WBGenie
  159. to use any of these. (i.e. WBGenie will launch any WB program, not just those
  160. I supply.) The underlying philosophy behind WBGenie is that the
  161. programs it launches should have simple intuitive interfaces which can be
  162. passed parameters via the WB.
  163.  
  164. WBGenie Key Features
  165. ~~~~~~~~~~~~~~~~~~~~
  166. WBGenie is 2.0 compatible only. It will only function under 2.0 or greater.
  167.  
  168. WBGenie is simple to use.
  169.  
  170. WBGenie closely follows the Commodore-Amiga Style Guide
  171.     (Let me know if you think there are any violations.)
  172.  
  173. WBGenie is intuitive.
  174.  
  175. WBGenie is a commodity.
  176.  
  177. WBGenie window is resizeable and can be snapshot.
  178.  
  179. WBGenie is configurable both in the sense that Wishes (tools) can be
  180.     configured and the operational setup can be configured without ever
  181.     having to use the keyboard.
  182.  
  183. WBGenie wish (tool) configuration produce project files with icons
  184.     (Note: icon generation is optional)
  185.  
  186. WBGenie has keyboard equivalents for gadgets and most menus items.
  187.  
  188. WBGenie honors the users screen font preference.
  189.  
  190. WBGenie will modify its own tool types when saving certain user setting
  191.     without affecting others as per the style guide.
  192.  
  193. WBGenie supports many tool types which allows the user to set many default
  194.     values.
  195.  
  196. WBGenie appicon is a cute little alladins lamp but the user can set any
  197.     icon to be the default appicon via the WBG_ICON tool type.  Alladins
  198.     lamp icon are provided in varying sizes so the user can select the
  199.     size which suits best.
  200.  
  201. WBGenie will add an assign to the directory from which it was run if it
  202.     wass run using the program icon. (WBGenie:=<path from which is was run>)
  203.  
  204. Terminology and Definitions
  205. ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  206.  
  207. Through out this documentation there are several terms and phrases which
  208. the reader should be familiar with. Below is a list describing them:
  209.  
  210.     WB              - work bench
  211.     CLI             - command line intereface
  212.     tool            - an application which can be run from the work bench
  213.                       and CLI
  214.     appicon         - a specal icon allowing users to interface with the
  215.                       application responsible for the icon.
  216.     appwindow       - a specal window allowing users to interface with the
  217.                       application responsible for the window normally by
  218.                       dropping an icon on to it.
  219.     drag and drop   - refers to the action of clicking an an icon and holding
  220.                       the button down and moving the mouse pointer over on
  221.                       appicon or appwindow and releasing the button.
  222.  
  223. Below is a list of terms specific to WBGenie and their defnitions:
  224.  
  225.     rub             - see "drag and drop" (they are idenitcal).
  226.     wish            - see tool (they are identical).
  227.     lamp            - this is an appicon representing Alladin's Lamp.
  228.     genie           - the WBGenie appwindow though which the user may make
  229.                       or configure wishes.
  230.  
  231. Configuring Wishes
  232. ~~~~~~~~~~~~~~~~~~
  233. Run WBGenie and double click on the lamp appicon which appears on the
  234. workbench. The WBGenie window will appear. This is an appwindow and dragging
  235. and dropping tools (wishes) on to the window will add them to the list
  236. gadget. Once you have finished configuring WBGenie you may save it to a file
  237. by selectng "save as" or "save" under the project menu.
  238.  
  239. An Example of how to use WBGenie
  240. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  241. When WBGenie is run by double clicking on its icon or from the CLI an
  242. appicon representing an Aladin's lamp is placed on the WB screen. Rubbing
  243. (where rubbing is defined as dragging and dropping icons on the lamp icon)
  244. the lamp with an icon or several icons, will summon the genie. The genie
  245. will contain a list of wishes which may be performed on the icons used to
  246. rub the lamp. Please note the tool selected must be able to accept
  247. parameters via the WB in order for the tool to operate on the icons. For
  248. instance if a text editor was selected as the wish then the text editor
  249. would be launched and it would automatically load the text files associated
  250. with the icons.
  251.  
  252. Brief History
  253. ~~~~~~~~~~~~~
  254. I had programmed in C on IBM compatibles commercially for 2 years and even
  255. though during this time and earlier I owned an Amiga 2000 I had never felt
  256. the urge to program on the Amiga. When WB2.0 came along things changed,
  257. at last an OS which could stack up against the likes of Microsoft Windows
  258. (WB2.0 incidently is far more advanced in most areas than MS Windows 3.1)
  259. and the Macintosh. The advent of 2.0 sparked my desire to try out some
  260. Amiga programming.
  261.  
  262. WBGenie evolved out of the dislike of using directory management programs
  263. or the CLI (Yuk!) to perform simple housekeeping tasks to the Amiga file
  264. system. The problem with directory management software is that they are big
  265. and cumbersome. They require a mental context switch when switching from the
  266. WB to the directory management software. I wrote WBGenie to be an interface
  267. to a series of simple utilities which will perform functions like those listed
  268. below:
  269.  
  270.     make assignment
  271.     Add or replace an icon
  272.     Delete an icon
  273.     make a link
  274.     copy, move or rename a file
  275.     compress a file
  276.     uncompress a file
  277.     Show IFF
  278.     Play IFF
  279.     Print file
  280.     read file (i.e. using narrator device)
  281.  
  282.  
  283. The WBGenie interface in its current form is very simple but elegant and at
  284. present maximum useability is obtained when using WBGenie in conjunction
  285. with Toolmanager (a WB tool launcher with a dock and Appmenu, available on
  286. fisk disk ???? which I highly recommend). Future version of the interface
  287. may include some or all of the toolmanager functionality. (Your input would
  288. be appreciated concerning the functionality you would like to see.)
  289.  
  290. The basic design principle governing WBGenie is elegance. This is the main
  291. reason for the absence of a CLI program launching cabability.
  292. If however, users find themselves using  WBGenie as merely
  293. a program launcher and would like CLI support then I will include it
  294. in the guise of a new product with a similar user interface.
  295.  
  296. Note however, the real aim of WBGenie is not to be just a program launcher
  297. but rather a WB interface to a series of WB programs which can be used to
  298. perform simple housekeeping funtions. I want WBGenie to be to WB what
  299. Nortons Desktop is to Microsoft Windows, only better.
  300.  
  301. An Example of how to use WBGenie
  302. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  303. When WBGenie is run by double clicking on its icon or from the CLI an
  304. appicon representing an Aladin's lamp is placed on the WB screen. Rubbing
  305. (where rubbing is defined as dragging and dropping icons on the lamp icon)
  306. the lamp with an icon or several icons, will summon the genie. The genie
  307. will contain a list of wishes which may be performed on the icons used to
  308. rub the lamp. Please note the tool selected must be able to accept
  309. parameters via the WB in order for the tool to operate on the icons. For
  310. instance if a text editor was selected as the wish then the text editor
  311. would be launched and it would automatically load the text files associated
  312. with the icons.
  313.  
  314. Below is a list of function which WBGenie may be configured to perform:
  315.  
  316.     make assignment
  317.     Add or replace an icon
  318.     Delete an icon
  319.     make a link
  320.     copy, move or rename a file
  321.     compress a file
  322.     uncompress a file
  323.     Show IFF
  324.     Play IFF
  325.     Print file
  326.     read file (i.e. using narrator device)
  327.  
  328.  
  329. Configuring WBGenie
  330. ~~~~~~~~~~~~~~~~~~~
  331. WBGenie allows many aspects of is operation to be customised. There are
  332. three groups of configuration, namely WBGenie Wishes, WBGenie State and
  333. WBGenie position. Below is a description of how these may be configured.
  334.  
  335. WBGenie Wishes
  336. ~~~~~~~~~~~~~~
  337. As already described, wishes are essentially tools which WBGenie may launch.
  338. Apon launch WBGenie passes the wish the icons which were used to summon the
  339. Genie. If no icons were passed the wish is still launched. (See example in
  340. section An Example of How to Use WBGenie).
  341.  
  342. To configure these wishes you simply run WBGenie in the usual fashion
  343. (either via CLI or WB) and double clicks on the lamp icon which appears on
  344. the WB. A window will appear (i.e. the Genie) onto which and you may drop
  345. tool icons. Continue dropping tool icons until all the required tools have
  346. been configured. You may now save this configuration via the "save" or "save
  347. as" menu option.
  348.  
  349. If "create icon" was checked in the menu when save was selected then a
  350. project icon will be created along with configuration file. Double clicking
  351. on this icon will start WBGenie with the saved config file. If you wish you
  352. may place this icon in the wbstartup drawer and WBGenie will be ready to
  353. summon immediately after boot up. Note that you my have to add the DONOTWAIT
  354. tool type to the project icon you copy to the wbstartup drawer.
  355.  
  356. WBGenie State
  357. ~~~~~~~~~~~~~
  358. The state refers to the following aspects of WBGenie operation:
  359.  
  360.     default save as name,
  361.     default state of "create icon" menu
  362.     default state of "save state" menu
  363.     default state of "save position menu
  364.     default wish (not used at present)
  365.     default state of stay (not used at present)
  366.     default state of lock (not used at present)
  367.  
  368. These default setting may be changed by adding or altering the tool types in
  369. the icon used to launch WBGenie (tool types are discussed below). These
  370. tooltypes my be changed manually or automatically by selecting the "save
  371. state" or "all" sub menu option. Note that the "all" option will save the
  372. position (discussed below) and the state.
  373.  
  374. WBGenie Position
  375. ~~~~~~~~~~~~~~~~
  376. The position refers to the default sceen location the Genie will appear at
  377. when it is summoned. This default location may be changed by adding or
  378. altering the tool types in the icon used to launch WBGenie (tool types are
  379. discussed below). These tooltypes my be changed manually or automatically by
  380. selecting the "save position" or "all" sub menu option. Note that the "all"
  381. option will save the state (discussed above) and the position.
  382.  
  383. WBGenie Tool Type
  384. ~~~~~~~~~~~~~~~~~
  385. Below is a list desribing the tool types which WBGenie understands:
  386.  
  387.     CX_PRIORITY       - see Amiga doc
  388.  
  389.     CX_POPUP          - see Amiga doc
  390.  
  391.     CX_POPKEY         - see Amiga doc
  392.  
  393.     WBG_CONFIG        - the default config file to load at start up
  394.                         usage: WBG_CONFIG=WBGenie.config
  395.  
  396.     WBG_SAVEAS        - the default file nae to show in the
  397.                         "save as file requestor"
  398.                         usage: WBG_SAVEAS=sys:WBGenie.config
  399.  
  400.     WBG_TOP_EDGE      - the default position of the top edge of the Genie
  401.                         usage: WBG_TOP_EDGE=10
  402.  
  403.     WBG_LEFT_EDGE     - the default position of the left edge of the Genie
  404.                         usage: WBG_LEFT_EDGE=10
  405.  
  406.     WBG_WIDTH         - the default width of the Genie
  407.                         usage: WBG_WIDTH_EDGE=180
  408.  
  409.     WBG_HEIGHT        - the default height of the Genie
  410.                         usage: WBG_HEIGHT_EDGE=180
  411.  
  412.     WBG_CREATE_ICONS  - if set to YES then the "create icons" menu will
  413.                         be checked.
  414.                         usage: WBG_CREATE_ICONS=NO
  415.  
  416.     WBG_SAVE_STATE    - if set to YES then the "save state" menu will be
  417.                         checked.
  418.                         usage: WBG_SAVE_STATE=NO
  419.  
  420.     WBG_SAVE_POSITION - if set to YES then the "save position" menu will be
  421.                         checked.
  422.                         usage: WBG_SAVE_POSITION=NO
  423.  
  424.     WBG_DEFAULT_TOOL  - not used
  425.  
  426.     WBG_STAY          - not used
  427.  
  428.     WBG_LOCK          - not used
  429.  
  430.  
  431. WBGenie Menus
  432. ~~~~~~~~~~~~~
  433. Below is a list desribing the WBGenie menus:
  434.  
  435.     Project
  436.         New           - Clears the current wish list
  437.  
  438.         Open...       - Brings up a file requestor from which a configuration
  439.                         file may be selected
  440.  
  441.         Save          - Saves the file to the default name of the opened file
  442.                         name
  443.  
  444.         Save As...    - Brings up a file requestor from which a save file
  445.                         name may be selected
  446.  
  447.         About...      - Displays general information about WBGenie
  448.  
  449.         Register...   - Prints out a registration form if this is the trial
  450.                         version of WBGenie otherwise details of registered
  451.                         user is displayed.
  452.  
  453.         Quit...       - Asks if you are sure you want to quit
  454.  
  455.     Window
  456.         Snapshot
  457.             All       - Will save both the state and position to the startup
  458.                         icon's tool types
  459.  
  460.             State     - Only the state will be saved
  461.  
  462.             Positon   - Only the position will be saved
  463.  
  464.     Settings
  465.         Create Icons  - If checked then project icons are created when
  466.                         configuration files are saved
  467.  
  468.         Save State    - If checked then the project icon created will contain
  469.                         tool types that reflect the current state.
  470.  
  471.         Save Position - If checked then the project icon created will contain
  472.                         tool types that reflect the current position.
  473.  
  474. Comming Attractions
  475. ~~~~~~~~~~~~~~~~~~~
  476. Below is a list of likely additions to WBGenie:
  477.  
  478.     Better font support - At present scaling of fonts does not occur in the
  479.                           in the X direction (Fonts larger than about 35 pts
  480.                           cause display problems).
  481.  
  482.     Make configuration files IFF files - If a WBGenie config file is dropped
  483.                                          on the Appwindow it will load the
  484.                                          configuration rather than add it to
  485.                                          the tool list.
  486.  
  487.     Support localization - The text strings will alter according to the
  488.                            WB's configured language.
  489.  
  490.     Add a Stay feature   - This would be either a menu option or gadget or
  491.                            both which would cause the launch window to remain
  492.                            open once a wish has been made.
  493.  
  494.     WBGenie path search  - If the tool is not found in its directory WBGenie
  495.                            will search the system path.
  496.  
  497.     display WBGenie activity messages on the Appwindow
  498.         (e.g. loading config file, saving config file, adding wishes etc.)
  499.  
  500.     "Save" operates same as "save as" menu when no name has been
  501.     established.
  502.  
  503.     Selecting the "New" menu will bring up an "are you sure" requester if the
  504.     current wish configuration has not been saved.
  505.  
  506. These additional features will only be added if users support the product
  507. so please register if you find it useful.
  508.